home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d3 / vde122.arc / VINST122.DOC < prev    next >
Text File  |  1988-08-17  |  23KB  |  434 lines
  1.  
  2.  
  3.  
  4.                                  VINST122.DOC
  5.                                  ------------ 
  6.                            [Supplement to VDE.DOC]
  7.  
  8.                     Instructions for VINSTALL 1.22 (08/88)
  9.                 Installation Utility for Video Display Editor
  10.                                 MSDOS Version
  11.  
  12.                                (c)1988 E. Meyer
  13.  
  14.  
  15.      VINSTALL is a utility that lets you customize your copy of the VDE 
  16. editor.  Most of this involves options that you need not concern yourself with 
  17. at first: in the course of using VDE, you will discover how you want these 
  18. things set.  However, there are important changes you will need to make to VDE 
  19. before using it, if you have a computer that:
  20.               * Is not fully IBM compatible (BIOS, video).
  21.               * Experiences "snow" problems with programs that write
  22.                  directly to video memory (older style CGA adapters).
  23.  
  24.      An uninstalled copy of VDE will ask you whether it is running on an IBM 
  25. compatible computer.  Once you have used VINSTALL this message will disappear.
  26.  
  27.      Note: VINSTALL modifies the file VDE.EXE.  Always keep an unmodified 
  28. original copy of all VDE files in case problems arise.
  29.  
  30.  
  31. =================================  CONTENTS  =================================
  32.  
  33.  
  34. 1. RUNNING VINSTALL.  How to use VINST.EXE to modify VDE.EXE.
  35.  
  36. 2. INSTALLATION.  Installing for different computer hardware:
  37.    ============   Screen size; IBM compatibility; Colors; Fonts; Snow.
  38.  
  39. 3. USER OPTIONS.  Customization of many initial VDE settings.
  40.  
  41. 4. PRINTER INSTALLATION.  Using special printer features:
  42.                           print modes, graphics, etc.
  43.  
  44. 5. MACRO KEYS.  Installing a default set of macro keys.
  45.  
  46. 6. FUNCTION KEYS.  Installing the function keys.
  47.  
  48. 7. GRAPHICS.  Modifying the default set of graphics characters.
  49.  
  50. 8. RESTORE DEFAULTS.  Undoing previous modifications.
  51.  
  52.  
  53. ===========================  1. RUNNING VINSTALL  ============================
  54.  
  55.  
  56.      Your copies of the program files will have names like VINST12.EXE and 
  57. VDE12.EXE.  Feel free to rename these to VINSTALL and VDE, as will be assumed 
  58. here.  When you run VINSTALL you must give it the name of a copy of VDE to 
  59. modify:
  60.                               A>vinstall vde.exe
  61.  
  62.      VINSTALL is fully menu-driven; it will present you with a set of 
  63. categories that corresponds to each section below, starting with Installation; 
  64. you select the values you want to change.
  65.      Note: the version numbers of VINSTALL and VDE (and any auxiliary key or 
  66. printer files, see below) must agree, or you will get an error.
  67.  
  68.      VINSTALL is largely self-documenting, and steps you through each item 
  69. individually.  If this is your first time running the program, take advantage 
  70. of its "Help" option before you start in, for some basic instructions.  You 
  71. may also find a good ASCII chart helpful.  VINSTALL uses several different 
  72. types of data entry:
  73.      TEXT - Just type in the character(s).
  74.      LOGICAL - Yes/No.  Just type "Y" or "N".
  75.      DECIMAL - Enter a number from 0 to 255.
  76.      HEX - Enter a two-digit hex byte value 00-FF.  (Don't omit lead zeros.)
  77.      BYTE STRINGS - fixed length: enter the required number of hex bytes.
  78.                     variable: enter the (hex) count for the number of bytes, 
  79.               followed by the bytes themselves.  Example:  (02)1B3D.  The max- 
  80.               imum length is given in square brackets [#].  This format is 
  81.               referred to below as "(#),bytes".
  82. VINSTALL can't check for illegal values; be careful what you enter!
  83.  
  84.      What follows is a more detailed explanation of installation items, in 
  85. about the same order as in the VINSTALL procedure.
  86.  
  87.  
  88. =============================  2. INSTALLATION  ==============================
  89.  
  90.  
  91.      When you run VINSTALL on an uninstalled copy of VDE, this selection will 
  92. be made automatically.  You must describe the computer you are using; most 
  93. importantly, whether it is 100% IBM PC compatible.
  94.      The IBM PC installation gives the best performance, but requires an IBM 
  95. standard BIOS and a supported video adapter (MDA,CGA,EGA,VGA).  You can 
  96. customize the display (colors, fonts etc) to your preferences.
  97.      The non-IBM installation will run on any system that supports ANSI 
  98. standard screen control sequences (eg, the ANSI.SYS screen driver -- you must 
  99. have DEVICE=ANSI.SYS in your CONFIG.SYS file).  You must also specify the size 
  100. of your screen.  This installation can also be used on IBM compatibles, in the 
  101. event that direct video access is undesirable.
  102.  
  103. COMMON PARAMETERS:
  104.  
  105. Clock speed in MHz (01-FF) - Set this hex value to reflect your CPU clock 
  106.     speed; common values are:     48 =  4.77 MHz       A0 = 10.0 MHz
  107.                                   80 =  8.0 MHz        C0 = 12.0 MHz
  108.     Adjust the value if desired to change the length of delays in VDE.  (You 
  109.     may need to increase this value for faster 80x86 computers.)
  110.  
  111. IS THIS AN IBM PC COMPATIBLE? - Set this to "Y" for best operation on a 
  112.     computer with fully IBM compatible BIOS and video adapter.  If you choose 
  113.     "N", no BIOS calls are used, and the screen is displayed (more slowly) 
  114.     with MSDOS standard character output.
  115.          The rest of the installation depends on your choice here.
  116.  
  117. IBM PC PARAMETERS:
  118.  
  119. Screen colors - you can select three video attribute bytes: one for normal 
  120.     text; one for the header and menus; and one for highlights (prompts, etc). 
  121.     Each is two hex digits, for a background and foreground color.  You will 
  122.     see a color palette displayed on screen; the color digits are:
  123.            *0 = BLACK   4 = red      *8 = GREY        C = brt red
  124.             1 = blue    5 = magenta   9 = brt blue    D = brt magenta
  125.             2 = green   6 = brown     A = brt green   E = yellow
  126.             3 = cyan   *7 = WHITE     B = brt cyan   *F = BRT WHITE
  127.     (*-Only 0,7,8,F work on monochrome systems.)
  128.          Any digit may be used for the the foreground, but only 0-7 for 
  129.     background (8-F produce blinking video...  ugh).  You will probably want 
  130.     the header and highlight attributes to have the same background.  The 
  131.     defaults are:   07 (white text on black) for normal video;
  132.                     7F (bright on white) for header;
  133.                     70 (black on white) for highlights.
  134.  
  135. Use VDE font in EGA mode (Y/N) - When the Alt-E command is used to display 43 
  136.     lines on an EGA (or 50 on VGA), you can choose one of two fonts.  VDE's 
  137.     own font is thinner than the ROM font, and you may find it more readable.  
  138.     "Y" selects this font; "N" selects the standard (fat) ROM font.
  139. Snow removal (Y/N) - Usually No; try this first.  Some older CGA systems 
  140.     experience ugly "snow" when programs write directly to video memory.  If 
  141.     this happens to you, set this option to "Y", and VDE will time its video 
  142.     access according to horizontal retrace intervals.  (Display speed will be 
  143.     slightly reduced.)
  144.  
  145. NON-IBM PC PARAMETERS: (automatically set for IBM PC)
  146.  
  147. Viewable columns (80-255) - normally 80; set to the column width of your 
  148.     display, if different.
  149. Viewable lines (16-255) - normally 25; if you have a shorter or longer default 
  150.     display (on entry to VDE), enter the length here.
  151. Enable fast scroll (Y/N) - Does your computer respond to the ANSI sequences 
  152.     for insert/delete line (Esc-[-L,M)?  If so, set this to "Y" for a faster 
  153.     display.  (Default is "N", as MSDOS ANSI.SYS does not support these codes; 
  154.     there are enhanced console drivers, such as NANSI.SYS, which do.  VDE will 
  155.     not work properly if you select "Y" when your console driver does not 
  156.     support these codes.)
  157. Horizontal scroll delay (01-FF) - This hex parameter creates a delay between 
  158.     scrolling the cursor line and the rest of the screen, when the screen 
  159.     shifts horizontally (past column 80).  A moderate delay is useful if your 
  160.     screen display is slow, as it minimizes interference with typing.  The 
  161.     default value is 40; you can adjust this to suit your taste.  (01=minimal; 
  162.     FF=very long, almost suppressing full redisplay.)
  163.  
  164.  
  165. =============================  3. USER OPTIONS  ===============================
  166.  
  167.  
  168.      You can select or change a variety of default settings in your copy of 
  169. VDE, according to your taste.  "Default" means the state assumed when VDE is 
  170. first run, or in the absence of any user commands.
  171.  
  172. Create BAKup files (Y/N) - Should a backup file be made when you save over an 
  173.     existing file?  Choose "Y" to play safe, "N" to save disk space.
  174. Mark end of file (Y/N) - Should an EOF marker (^Z, 1Ah) be placed at the end 
  175.     of a file when writing to disk?  Most software won't care; some early 
  176.     MSDOS software may require this.  Originally No.
  177. Default file mode (W/A/N) -  Which of the three file modes "W","A","N" 
  178.     described in VDE.DOC do you want as the default?  (Originally "A".)
  179. Auto mode select filetypes - You can specify two filetypes (or type masks, 
  180.     using "?" wildcards) as exceptions to the above default: for example, you 
  181.     could declare all ".ASM" files to be automatically "N" mode, or all files 
  182.     ".?88" to be "W" mode.  Any mode option ("/M") explicitly specified still 
  183.     overrides this.
  184. Drive to find COMMAND.COM - In order for VDE's Alt-R (Run) command to work, it 
  185.     must be able to find a copy of the DOS command interpreter.  It will look 
  186.     in the root directory of the drive you specify here.  The original setting 
  187.     is for the current default drive, indicated by "@".
  188.  
  189. Default insert on (Y/N) - Do you want the INSERT toggle to start out ON when 
  190.     first entering VDE?  (Originally No.)
  191. Default ruler on (Y/N) - Do you want the Ruler line (^OT) to start out ON when 
  192.     first entering VDE?  (Originally No.)
  193. Default HCR display on (Y/N) - Do you want Hard CR display (^OD) to start out 
  194.     ON when entering a Document ("W/A" modes) with VDE?  (Originally Yes.)  
  195.     The default is always OFF in "N" mode.
  196. Default hyphenation on (Y/N) - Do you want hyphenation (^OH) to start out ON 
  197.     when first entering VDE?  (Originally Yes.)
  198. Default case-insensitive search (Y/N) - Do you want string searches (^QF) to 
  199.     be case insensitive by default?  (Originally No.)  If yes, the /I/ option 
  200.     will force a case sensitive search.
  201.  
  202. Left and Right margin columns (1-255) - Default margin settings for "W/A" 
  203.     modes.  Set both to 1 to entirely disable wordwrap and reformatting.
  204. Suppress header by default (Y/N) - Do you want the header display (^OQ) to 
  205.     start out OFF when first entering VDE?  (Originally No.)
  206. Scroll overlap (0-255) - This is the number of lines overlap between screens 
  207.     when scrolling with ^R/^C.  The smaller, the larger the scroll.  
  208.     Originally set to 2, for a nearly full scroll.  Keep this smaller than 
  209.     your screen size!
  210.  
  211. Ring bell on error (Y/N) - Do you want the bell to ring when a VDE error 
  212.     message displays?  (Originally No.)
  213. BS (^H) deletes to left (Y/N) - Do you want the Backspace (^H) key to delete 
  214.     characters?  Originally No - it just moves the cursor left nondestruc- 
  215.     tively, as in WordStar.
  216. DEL deletes to right (Y/N) - Do you want the Delete key to remove the charac- 
  217.     ter to the right?  Originally No - it deletes to the left, as in WordStar.
  218.  
  219. Hard Tab display spacing -  This determines how any hard Tabs (^I) in your 
  220.     text will display.  Usually 8, this can be made 2, 4, 16, or any other 
  221.     power of two.  Other values will produce erratic results.
  222. Variable tab stops -  Enter up to 8 variable tab stop columns, in ascending 
  223.     order.  Fill unused values with 0.  Defaults: 6, 15, 35, 55.
  224.  
  225. Show time as AM/PM (Y/N) - Do you want the Time stamp to display in 12 hour 
  226.     format (eg 1:21 PM)?  Originally Yes.  If No, the time shows in 24 hour 
  227.     format (eg 13:21).
  228. Show date as Day,Month (Y/N) - Do you want the Date stamp to display in 
  229.     European format (eg 15 January)?  Originally No, meaning US Format (Month, 
  230.     Day, eg January 15).
  231.  
  232. DEFAULT CHARACTERS:
  233.      You will be asked whether (Y/N) you want to continue to this section.  
  234. Ordinarily you will NOT want to.  However, if you find that VDE's standard 
  235. assignment of characters conflicts with some special application, you can 
  236. change these values.  If you do, remember the new ones!
  237.      For the control codes, use only ASCII 00-1F.  Avoid codes with standard 
  238. meanings: ^H,I,J,L,M,Z (ASCII 08,09,0A,0C,0D,1A).  If you like, you can fill 
  239. unused places in the Print toggles/switches section with 0FFh.
  240.  
  241. Wildcard character - Normally "_", this is the character that will be taken as 
  242.     a wildcard (and case ignore flag) in FIND strings.
  243. Block mark character (00-1F) - Usually 00 (^@), this is the control code that 
  244.     temporarily marks off a block.
  245. Print Toggles (00-1F) - These codes, normally ^B,^D,^S,^Y,^T,^V, call up the 
  246.     toggles defined in your printer installation.
  247. Print Switches (00-1F) - These codes, normally ^Q,^W,^E,^R,^A,^N, call up the 
  248.     switches defined in your printer installation.
  249.  
  250.  
  251. =========================  4. PRINTER INSTALLATION  ==========================
  252.  
  253.  
  254.      Printers vary enormously.  By default VDE uses a very simple printing 
  255. routine that will always work, but can't take advantage of your printer's 
  256. special features.  You will want to improve on this.
  257.      VINSTALL can use special Printer Installation files to store printer 
  258. definitions.  These should have a file type of ".VDP".  You have the option to 
  259. read in or write out such a file, as well as editing the following values 
  260. individually.  This makes it easy to pass your installation along to others.
  261.      VDE.ARC includes two basic printer drivers, EPSONFX.VDP and EPSONLQ.VDP.  
  262. Both implement the print toggles and switches according to their usual 
  263. WordStar purposes (see below); the difference is in their handling of 
  264. graphics.  You can modify these, or construct your own from scratch.
  265.  
  266. Printer ID - Identify the printer you are installing.  (16 characters)
  267.  
  268. IBM graphics printer (Y/N) - Normally No; if you can print the IBM extended 
  269.     ASCII characters, set this to Yes.  If No, VDE will "emulate" graphics on 
  270.     printing, choosing standard character combinations that come close.  (Try 
  271.     this out; it's very useful.)
  272. Send LF after CR (Y/N) - Normally Yes.  But with some printers, which manufac- 
  273.     ture their own LF on receiving a CR, you will want No here.
  274.  
  275. Page length (0-255) - Set the number of text lines to print on a page.  (Does 
  276.     not include another 3 lines for a header, if used.)  Setting to 0 disables 
  277.     pagination permanently.
  278. Top margin (0-255) - Set the number of blank lines to skip as a top margin 
  279.     before printing each page.  This value (not included in the page length) 
  280.     can be used to position the paper properly.  Default is 0.
  281. Left margin (0-255) - Set the number of blank columns to skip as a left margin 
  282.     before printing each line.  Useful if you can't set the margin on your 
  283.     printer with an initialization string.  Default is 0.
  284.  
  285. Printer initialization - Enter an optional string of code (#),bytes to send to 
  286.     the printer before each print job, to set default margins, print modes etc.
  287. Printer uninit - Enter another optional string (#),bytes to send to the 
  288.     printer after each print job, to restore printer to desired state on exit.
  289.  
  290. Codes for toggles (on/off) - For each of the six printer toggles, you need to 
  291.     tell VDE the codes to send to your printer to produce the desired effect, 
  292.     then turn it off again.  The conventional meanings of the toggles are:
  293.          ^B  boldface         ^S  underline          ^T  superscript
  294.          ^D  doublestrike     ^Y  ribbon/italic      ^V  subscript
  295.     but you can use them for anything you want.  Example: Your printer 
  296.     requires the codes ESC-U-01 to turn underlining on, and ESC-U-00 to turn 
  297.     it off.  You would enter (starting with the byte count):
  298.               ^S toggle on [07]:  (03)1B5501
  299.                     and off [07]:  (03)1B5500
  300.     You should find the necessary ASCII hex codes in your printer manual.
  301. Codes for switches - The same idea, but for switches, which send the same 
  302.     codes every time they are used.  WordStar calls the switches:
  303.           ^Q,^W,^E,^R  user1...4       ^A,^N  alternate, normal pitch
  304.     but you can use them for anything you want.
  305.  
  306.  
  307. ==============================  5. MACRO KEYS  ===============================
  308.  
  309.  
  310.      The default macro definitions are those attached to the commands Esc-0..9 
  311. when VDE is first entered.  By changing them you can configure VDE to suit 
  312. your own specialized writing requirements.  (Any Keys defined with Esc-# while 
  313. running VDE override the defaults.)
  314.      VINSTALL can use Key Definition files to store macro key sets.  These 
  315. should have a file type of ".VDK", and are compatible with those used by the 
  316. CP/M VDE, except that they will extend to 1024 bytes rather than 512.  You 
  317. have the option to read in or write out such a file, as well as editing the 
  318. keys individually.
  319.      VINSTALL gives you a display much like this:
  320.  
  321.       Macro Keys:  (03C6 bytes free)      <---- note room (up to 03F4 = 1012)
  322.       [Esc-0]<>
  323.       [Esc-1]<>                           <---- "<>" flag means empty
  324.       [Esc-2]<>
  325.       [Esc-3]^[;^C                        <---- normal macro key
  326.       [Esc-4]<>
  327.       [Esc-5]<N>World Wide Widgets Inc.   <---- "<N>" flag means no-rpt key
  328.       [Esc-6]<>
  329.       [Esc-7]<Q>^QR^KB^QC^KK^KC           <---- "<Q>" flag means quiet key
  330.       [Esc-8]<>
  331.       [Esc-9]<>
  332.  
  333. This is pretty straightforward; you just select the number of the Key you wish 
  334. to redefine, then type in the new definition, much as you would in VDE.  All 
  335. the same rules apply (but VINSTALL will accept longer keys, up to 128 bytes).  
  336. If the new definition is too long to fit it will be rejected.
  337.      VDE.ARC comes with a macro key file EXAMPLES.VDK, containing three 
  338. example macros taken from VDE.DOC:
  339.  
  340.      [Esc-1]<Q>^QR^N^[^[D^OF
  341.      [Esc-2]<Q>^[~.1^S^[1^[~.<^[2^D^[= 2^[=^M2
  342.      [Esc-3]<Q>^QS^X^[=^M]^S^V ^V^D^[![
  343.  
  344. These are: Put date at top right of file; Move to start of current sentence; 
  345. Soften a hard-CR paragraph.  (Note that "Esc" displays as "^[".)
  346.  
  347.  
  348. ============================  6. FUNCTION KEYS  ==============================
  349.  
  350.  
  351.      VDE also has a set of forty Function-keys, corresponding to the [F1]... 
  352. [F10] keys in their normal, Shift-, Ctrl-, and Alt- usage.  These are very 
  353. similar to the MACRO keys discussed above, except: they are shorter (32 bytes 
  354. maximum); they are always "quiet, no repeat"; and they cannot be changed on 
  355. the spot within VDE.  You can easily configure these to match the standard 
  356. function-key configuration for Wordstar's key overlay, or in any other way you 
  357. like.
  358.      VINSTALL can use Function-key Definition files to store function key 
  359. sets.  These should have a file type of ".VDF".  (They are not interchangable 
  360. with ".VDK" files.)  You have the option to read in or write out such a file, 
  361. as well as editing the keys individually.
  362.      VINSTALL gives you a display much like this:
  363.  
  364.       Function keys:  (01C9 bytes free)  <---- note room (up to 01D6 = 470)
  365.       [F1]<>
  366.       [F2]<>                             <---- "<>" flag means empty
  367.       [F3]<>
  368.       [F4]^OL5^M^OR60^M                  <---- normal function key
  369.       [F5]<>
  370.       [F6]<>
  371.       [F7]<>
  372.       [F8]<>
  373.       [F9]^PS
  374.       [F0]^PY
  375.  
  376. This works just like the macro keys above, except there are four sets of 10 
  377. keys to define (<N>ormal, <S>hift, <C>trl, <A>lt).
  378.      VDE.ARC includes a sample file WS4.VDF, which you can read in to define 
  379. the function keys according to the WordStar 4 default usage:
  380.  
  381.              NORMAL      SHIFT        CTRL             ALT
  382.      [F1]     ^J          ^OD          ^QF         Vertical bar graphic
  383.      [F2]     ^U          ^OC          ^QA         Horizontal bar
  384.      [F3]     ^PS                      ^L          Upper-left corner
  385.      [F4]     ^PB                      ^QI         Upper-right corner
  386.      [F5]     ^Y          ^KY          ^OL         Lower-left corner
  387.      [F6]     ^T          ^KU          ^OR         Lower-right corner
  388.      [F7]                 ^KV                      Upper T
  389.      [F8]                 ^KC                      Lower T
  390.      [F9]     ^KS         ^KB          ^QS         Left T
  391.      [F10]    ^KD         ^KK          ^QD         Right T
  392.  
  393.  
  394. ==========================  7. GRAPHICS CHARACTERS  ==========================
  395.  
  396.  
  397.      VDE's handling of graphics assumes an IBM compatible PC.  However, it may 
  398. work usefully for other MSDOS computers, if your video system supports a set 
  399. of extra characters for ASCII codes with the high bit set.
  400.      VDE allows text to contain a limited (but variable) set of 32 IBM 
  401. graphics characters, restricted to the ASCII range 80-FE.  (These are entered 
  402. with the Alt-G command in VDE.)  The default set includes box pieces and other 
  403. useful things, and has some room free, but you can change it to include 
  404. whatever you need.  The important thing to remember is that these are the only 
  405. graphics codes that VDE can manage: if you load a file containing graphics not 
  406. in this set, unless there is room to add them, they will turn into grey blobs 
  407. (graphic #6)!  So don't feel obliged to fill your set completely.
  408.      You will be shown the current definitions, in the same format as the VDE 
  409. Alt-G command.  You can pick any one (A-Z, 1-5) to change, or type "-" to 
  410. clear them all.  (Graphic 6 cannot be changed; it always remains a grey blob.) 
  411. New graphic codes are entered by hex value, from 80 to FE; a full list of 
  412. graphics characters can be displayed for your selection if you need it, by 
  413. typing "?".  An entry of FF is considered "open", and can be used on loading a 
  414. file to accomodate any extra characters needed.
  415.      Note that your Printer Installation determines how graphics will print.
  416.  
  417.  
  418.  
  419. ===========================  8. RESTORE DEFAULTS  ============================
  420.  
  421.  
  422.      This option on the VINSTALL menu is provided in the event that you want 
  423. to undo any changes that you (or someone else) has made to your copy of VDE.  
  424. This should return VDE to the state it was distributed in: installation for 
  425. IBM PC, all User Options restored to their defaults, printer set to a basic 
  426. Teletype, no Macro or Function Keys, original Graphics characters.
  427.  
  428.  
  429.  
  430.  
  431.          ---  Eric Meyer, 401 12th Ave SE #139, Norman OK 73071  ---
  432.  
  433. ==============================================================================
  434.